/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
 * in the United States and other countries.]
 *
 * --------------------
 * PlotChangeEvent.java
 * --------------------
 * (C) Copyright 2000-2008, by Object Refinery Limited.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * Changes (from 24-Aug-2001)
 * --------------------------
 * 24-Aug-2001 : Added standard source header. Fixed DOS encoding problem (DG);
 * 07-Nov-2001 : Updated header (DG);
 * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
 * 17-Jan-2003 : Moved plot classes to a separate package (DG);
 *
 */

package org.jfree.chart.event;

import java.awt.geom.Rectangle2D;

import org.jfree.chart.plot.Plot;
import org.jfree.data.general.Dataset;
import org.jfree.data.general.DatasetChangeEvent;

/**
 * An event that can be forwarded to any
 * {@link org.jfree.chart.event.PlotChangeListener} to signal a change to a
 * plot.
 */
public class PlotChangeEvent extends ChartChangeEvent {

    /** The plot that generated the event. */
    private Plot plot;

    // DA_SPECIFIC ---->
	/**
	 * The updated plot area in which values are changed in axis coordinates or <code>null</code>.
	 * 
	 * @see DatasetChangeEvent
	 */
	private Rectangle2D	changedArea;
	/** The changed dataset. */
	Dataset				changedDataset;
	// ---->      
    
    /**
     * Creates a new PlotChangeEvent.
     *
     * @param plot  the plot that generated the event.
     */
    public PlotChangeEvent(Plot plot) {
    	// DA_SPECIFIC ---->
		this(plot, null, null);
		// ---->
    }

    // DA_SPECIFIC ---->
	/**
	 * Creates a new PlotChangeEvent.
	 * 
	 * @param plot the plot that generated the event.
	 * @param changedArea the changed area or <code>null</code>.
	 * @param changedDataset the changed dataset or <code>null</code>.
	 */
	public PlotChangeEvent(Plot plot, Rectangle2D changedArea, Dataset changedDataset) {
		super(plot);
		this.plot = plot;
		if (changedArea != null) {
			this.changedArea = new Rectangle2D.Double(changedArea.getX(), changedArea.getY(), changedArea.getWidth(), changedArea
				.getHeight());
		}
		this.changedDataset = changedDataset;
	}
	// ---->
    
    /**
     * Returns the plot that generated the event.
     *
     * @return The plot that generated the event.
     */
    public Plot getPlot() {
        return this.plot;
    }
    
    // DA_SPECIFIC ---->
	/**
	 * @return the area in which values are changed in axis coordinates or <code>null</code>.
	 */
	public Rectangle2D getChangedArea() {
		return changedArea;
	}
	// ---->
	
	// DA_SPECIFIC --->
	/**
	 * @return the changed dataset or <code>null</code>.
	 */
	public Dataset getChangedDataset() {
		return changedDataset;
	}
	// ---->

}
